<!DOCTYPE html>
<!-- Generated by pkgdown: do not edit by hand --><html lang="en"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><meta charset="utf-8"><meta http-equiv="X-UA-Compatible" content="IE=edge"><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><title>Utility to download / load datasets from pin board — dataload_from_pins • EJAM</title><!-- favicons --><link rel="icon" type="image/png" sizes="16x16" href="../favicon-16x16.png"><link rel="icon" type="image/png" sizes="32x32" href="../favicon-32x32.png"><link rel="apple-touch-icon" type="image/png" sizes="180x180" href="../apple-touch-icon.png"><link rel="apple-touch-icon" type="image/png" sizes="120x120" href="../apple-touch-icon-120x120.png"><link rel="apple-touch-icon" type="image/png" sizes="76x76" href="../apple-touch-icon-76x76.png"><link rel="apple-touch-icon" type="image/png" sizes="60x60" href="../apple-touch-icon-60x60.png"><script src="../deps/jquery-3.6.0/jquery-3.6.0.min.js"></script><meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no"><link href="../deps/bootstrap-5.3.1/bootstrap.min.css" rel="stylesheet"><script src="../deps/bootstrap-5.3.1/bootstrap.bundle.min.js"></script><link href="../deps/font-awesome-6.4.2/css/all.min.css" rel="stylesheet"><link href="../deps/font-awesome-6.4.2/css/v4-shims.min.css" rel="stylesheet"><script src="../deps/headroom-0.11.0/headroom.min.js"></script><script src="../deps/headroom-0.11.0/jQuery.headroom.min.js"></script><script src="../deps/bootstrap-toc-1.0.1/bootstrap-toc.min.js"></script><script src="../deps/clipboard.js-2.0.11/clipboard.min.js"></script><script src="../deps/search-1.0.0/autocomplete.jquery.min.js"></script><script src="../deps/search-1.0.0/fuse.min.js"></script><script src="../deps/search-1.0.0/mark.min.js"></script><!-- pkgdown --><script src="../pkgdown.js"></script><meta property="og:title" content="Utility to download / load datasets from pin board — dataload_from_pins"><meta name="description" content="Utility to download / load datasets from pin board"><meta property="og:description" content="Utility to download / load datasets from pin board"><meta property="og:image" content="https://usepa.github.io/EJAM/logo.svg"></head><body>
    <a href="#main" class="visually-hidden-focusable">Skip to contents</a>


    <nav class="navbar navbar-expand-lg fixed-top bg-light" data-bs-theme="light" aria-label="Site navigation"><div class="container">

    <a class="navbar-brand me-2" href="../index.html">EJAM</a>

    <small class="nav-text text-warning me-auto" data-bs-toggle="tooltip" data-bs-placement="bottom" title="Released version">2.32.0</small>


    <button class="navbar-toggler" type="button" data-bs-toggle="collapse" data-bs-target="#navbar" aria-controls="navbar" aria-expanded="false" aria-label="Toggle navigation">
      <span class="navbar-toggler-icon"></span>
    </button>

    <div id="navbar" class="collapse navbar-collapse ms-3">
      <ul class="navbar-nav me-auto"><li class="active nav-item"><a class="nav-link" href="../reference/index.html">Reference</a></li>
<li class="nav-item dropdown">
  <button class="nav-link dropdown-toggle" type="button" id="dropdown-articles" data-bs-toggle="dropdown" aria-expanded="false" aria-haspopup="true">Articles</button>
  <ul class="dropdown-menu" aria-labelledby="dropdown-articles"><li><hr class="dropdown-divider"></li>
    <li><h6 class="dropdown-header" data-toc-skip>Overview for EJAM Users</h6></li>
    <li><a class="dropdown-item" href="../articles/0_whatis.html">What is EJAM</a></li>
    <li><a class="dropdown-item" href="../articles/0_webapp.html">Using EJAM</a></li>
    <li><hr class="dropdown-divider"></li>
    <li><h6 class="dropdown-header" data-toc-skip>For analysts using R</h6></li>
    <li><a class="dropdown-item" href="../articles/1_installing.html">Installing the EJAM R package</a></li>
    <li><a class="dropdown-item" href="../articles/2_quickstart.html">Quick Start Guide</a></li>
    <li><a class="dropdown-item" href="../articles/3_analyzing.html">Basics of Using EJAM for Analysis in RStudio</a></li>
    <li><a class="dropdown-item" href="../articles/4_advanced.html">Advanced Features</a></li>
  </ul></li>
<li class="nav-item"><a class="nav-link" href="../news/index.html">Changelog</a></li>
      </ul><ul class="navbar-nav"><li class="nav-item"><form class="form-inline" role="search">
 <input class="form-control" type="search" name="search-input" id="search-input" autocomplete="off" aria-label="Search site" placeholder="Search for" data-search-index="../search.json"></form></li>
      </ul></div>


  </div>
</nav><div class="container template-reference-topic">
<div class="row">
  <main id="main" class="col-md-9"><div class="page-header">
      <img src="../logo.svg" class="logo" alt=""><h1>Utility to download / load datasets from pin board</h1>
      <small class="dont-index">Source: <a href="https://github.com/USEPA/EJAM/blob/HEAD/R/dataload_from_pins.R" class="external-link"><code>R/dataload_from_pins.R</code></a></small>
      <div class="d-none name"><code>dataload_from_pins.Rd</code></div>
    </div>

    <div class="ref-description section level2">
    <p>Utility to download / load datasets from pin board</p>
    </div>

    <div class="section level2">
    <h2 id="ref-usage">Usage<a class="anchor" aria-label="anchor" href="#ref-usage"></a></h2>
    <div class="sourceCode"><pre class="sourceCode r"><code><span><span class="fu">dataload_from_pins</span><span class="op">(</span></span>
<span>  varnames <span class="op">=</span> <span class="va">.arrow_ds_names</span><span class="op">[</span><span class="fl">1</span><span class="op">:</span><span class="fl">3</span><span class="op">]</span>,</span>
<span>  boardfolder <span class="op">=</span> <span class="st">"Mark"</span>,</span>
<span>  auth <span class="op">=</span> <span class="st">"auto"</span>,</span>
<span>  server <span class="op">=</span> <span class="st">"https://rstudio-connect.dmap-stage.aws.epa.gov"</span>,</span>
<span>  folder_local_source <span class="op">=</span> <span class="cn">NULL</span>,</span>
<span>  envir <span class="op">=</span> <span class="fu"><a href="https://rdrr.io/r/base/environment.html" class="external-link">globalenv</a></span><span class="op">(</span><span class="op">)</span>,</span>
<span>  justchecking <span class="op">=</span> <span class="cn">FALSE</span>,</span>
<span>  ignorelocal <span class="op">=</span> <span class="cn">FALSE</span>,</span>
<span>  silent <span class="op">=</span> <span class="cn">FALSE</span>,</span>
<span>  onAttach <span class="op">=</span> <span class="cn">FALSE</span></span>
<span><span class="op">)</span></span></code></pre></div>
    </div>

    <div class="section level2">
    <h2 id="arguments">Arguments<a class="anchor" aria-label="anchor" href="#arguments"></a></h2>


<dl><dt id="arg-varnames">varnames<a class="anchor" aria-label="anchor" href="#arg-varnames"></a></dt>
<dd><p>character vector of names of R objects to get from board,
or set this to "all" to load all of them</p></dd>


<dt id="arg-boardfolder">boardfolder<a class="anchor" aria-label="anchor" href="#arg-boardfolder"></a></dt>
<dd><p>if needed to specify a different folder than default</p></dd>


<dt id="arg-auth">auth<a class="anchor" aria-label="anchor" href="#arg-auth"></a></dt>
<dd><p>See help documentation for <code><a href="https://pins.rstudio.com/reference/board_connect.html" class="external-link">pins::board_connect()</a></code></p></dd>


<dt id="arg-server">server<a class="anchor" aria-label="anchor" href="#arg-server"></a></dt>
<dd><p>if needed to specify a server other than default (which might be
stored in envt variable CONNECT_SERVER or be registered via the rsconnect package).
Note if auth = "envvar" then it looks for CONNECT_SERVER to get name of server which
needs to be the full url starting with https:// - see help for board_connect</p></dd>


<dt id="arg-folder-local-source">folder_local_source<a class="anchor" aria-label="anchor" href="#arg-folder-local-source"></a></dt>
<dd><p>path of local folder to
look in for locally saved copies in case pins board is not reachable by user.</p></dd>


<dt id="arg-envir">envir<a class="anchor" aria-label="anchor" href="#arg-envir"></a></dt>
<dd><p>if needed to specify environment other than default, e.g., globalenv() or parent.frame()</p></dd>


<dt id="arg-justchecking">justchecking<a class="anchor" aria-label="anchor" href="#arg-justchecking"></a></dt>
<dd><p>can set to TRUE to just see a list of what pins are stored in that board</p></dd>


<dt id="arg-ignorelocal">ignorelocal<a class="anchor" aria-label="anchor" href="#arg-ignorelocal"></a></dt>
<dd><p>set it to TRUE to avoid 1st checking local disk for copies of files</p></dd>


<dt id="arg-silent">silent<a class="anchor" aria-label="anchor" href="#arg-silent"></a></dt>
<dd><p>set to TRUE to suppress cat() msgs to console</p></dd>


<dt id="arg-onattach">onAttach<a class="anchor" aria-label="anchor" href="#arg-onattach"></a></dt>
<dd><p>Indicates whether the function is being called from onAttach. IF so, it will download all arrow files if user cannot connect to PINS board</p></dd>

</dl></div>
    <div class="section level2">
    <h2 id="value">Value<a class="anchor" aria-label="anchor" href="#value"></a></h2>
    <p>If justchecking = FALSE,</p>
<p>returns vector of names of objects now in memory in specified envir, either because</p><ol><li><p>already in memory or</p></li>
<li><p>loaded from local disk or</p></li>
<li><p>successfully downloaded.</p></li>
</ol><p>If justchecking = TRUE, however,</p>
<p>returns vector of names of ALL objects found in specified pin board (or NULL if cannot connect)</p>
<p>regardless of whether they are already in the environment, and</p>
<p>regardless of whether they were specified among varnames, or are related to EJAM at all.</p>
    </div>
    <div class="section level2">
    <h2 id="details">Details<a class="anchor" aria-label="anchor" href="#details"></a></h2>
    <p>This does work if on VPN and if credentials already set up for the user doing this:</p>
<p>board &lt;- pins::board_connect(auth = "rsconnect")</p>
<p>This does work if that is true plus the two environment variables were created:</p>
<p></p><div class="sourceCode"><pre><code><span id="cb1-1"><a href="#cb1-1" tabindex="-1"></a>board <span class="ot">&lt;-</span> pins<span class="sc">::</span><span class="fu">board_connect</span>(<span class="at">auth =</span> <span class="st">'manual'</span>,</span>
<span id="cb1-2"><a href="#cb1-2" tabindex="-1"></a>  <span class="at">server =</span> <span class="fu">Sys.getenv</span>(<span class="st">"CONNECT_SERVER"</span>),</span>
<span id="cb1-3"><a href="#cb1-3" tabindex="-1"></a>  <span class="at">key =</span> <span class="fu">Sys.getenv</span>(<span class="st">"CONNECT_API_KEY"</span>)</span>
<span id="cb1-4"><a href="#cb1-4" tabindex="-1"></a>)</span></code></pre><p></p></div>
<p></p><div class="sourceCode"><pre><code><span id="cb1-1"><a href="#cb1-1" tabindex="-1"></a>after <span class="fu">Sys.setenv</span>(<span class="at">CONNECT_SERVER =</span> <span class="st">"https://rstudio-connect.dmap-stage.aws.epa.gov"</span>)</span>
<span id="cb1-2"><a href="#cb1-2" tabindex="-1"></a></span>
<span id="cb1-3"><a href="#cb1-3" tabindex="-1"></a>and   <span class="fu">Sys.setenv</span>(<span class="at">CONNECT_API_KEY =</span>  correct<span class="sc">-</span>API<span class="sc">-</span>key<span class="sc">-</span>goes<span class="sc">-</span>here  )</span></code></pre><p></p></div>
    </div>

  </main><aside class="col-md-3"><nav id="toc" aria-label="Table of contents"><h2>On this page</h2>
    </nav></aside></div>


    <footer><div class="pkgdown-footer-left">
  <p>US EPA 2025</p>
</div>

<div class="pkgdown-footer-right">
  <p>EJAM Version 2.32.0</p>
</div>

    </footer></div>





  </body></html>

